<!DOCTYPE html>
<html lang="en">

<head>
	<meta charset="UTF-8">
	<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=no">
	<meta name="keywords" content="贡献,源码" />
	<meta name="description" content="我们非常欢迎您的贡献和加入，无论是微不足道的清理或大的新功能。" />
	<!-- 网页标签标题 -->
	<title>如何贡献</title>
	<link rel="shortcut icon" href="https://img.alicdn.com/tfs/TB1hgJpHAPoK1RjSZKbXXX1IXXa-64-64.png"/>
	<link rel="stylesheet" href="/build/documentation.css" />
</head>
<body>
	<div id="root"><div class="documentation-page" data-reactroot=""><header class="header-container header-container-normal"><div class="header-body"><a href="/zh-cn/index.html"><img class="logo" src="/img/nacos_colorful.png"/></a><div class="search search-normal"><span class="icon-search"></span></div><span class="language-switch language-switch-normal">En</span><div class="header-menu"><img class="header-menu-toggle" src="/img/menu_gray.png"/><ul><li class="menu-item menu-item-normal"><a href="/zh-cn/index.html">首页</a></li><li class="menu-item menu-item-normal menu-item-normal-active"><a href="/zh-cn/docs/what-is-nacos.html">文档</a></li><li class="menu-item menu-item-normal"><a href="/zh-cn/blog/index.html">博客</a></li><li class="menu-item menu-item-normal"><a href="/zh-cn/community/index.html">社区</a></li><li class="menu-item menu-item-normal"><a href="https://cn.aliyun.com/product/aliware/mse?spm=nacos-website.topbar.0.0.0">企业版Nacos</a><img class="menu-img" src="https://img.alicdn.com/tfs/TB1esl_m.T1gK0jSZFrXXcNCXXa-200-200.png"/></li><li class="menu-item menu-item-normal"><a href="http://console.nacos.io/nacos/index.html">控制台样例</a></li></ul></div></div></header><div class="bar"><div class="bar-body"><img src="/img/docs.png" class="front-img"/><div class="bar-title"><span>Nacos 文档</span><div class="bone bone-light"></div></div><img src="/img/docs.png" class="back-img"/></div></div><section class="content-section"><div class="content-body"><div class="sidemenu"><div class="sidemenu-toggle"><img src="https://img.alicdn.com/tfs/TB1E6apXHGYBuNjy0FoXXciBFXa-200-200.png"/></div><ul><li class="menu-item menu-item-level-1"><span>Nacos </span><ul><li style="height:180px;overflow:hidden" class="menu-item menu-item-level-2"><span>Nacos是什么?<img style="transform:rotate(0deg)" class="menu-toggle" src="/img/arrow_down.png"/></span><ul><li class="menu-item menu-item-level-3"><a href="/zh-cn/docs/what-is-nacos.html" target="_self">Nacos简介</a></li><li class="menu-item menu-item-level-3"><a href="/zh-cn/docs/concepts.html" target="_self">概念</a></li><li class="menu-item menu-item-level-3"><a href="/zh-cn/docs/architecture.html" target="_self">架构</a></li><li class="menu-item menu-item-level-3"><a href="/zh-cn/docs/feature-list.html" target="_self">功能和需求列表</a></li></ul></li><li style="height:324px;overflow:hidden" class="menu-item menu-item-level-2"><span>快速开始<img style="transform:rotate(0deg)" class="menu-toggle" src="/img/arrow_down.png"/></span><ul><li class="menu-item menu-item-level-3"><a href="/zh-cn/docs/quick-start.html" target="_self">Nacos</a></li><li class="menu-item menu-item-level-3"><a href="/zh-cn/docs/quick-start-spring.html" target="_self">Nacos Spring</a></li><li class="menu-item menu-item-level-3"><a href="/zh-cn/docs/quick-start-spring-boot.html" target="_self">Nacos Spring Boot</a></li><li class="menu-item menu-item-level-3"><a href="/zh-cn/docs/quick-start-spring-cloud.html" target="_self">Nacos Spring Cloud</a></li><li class="menu-item menu-item-level-3"><a href="/zh-cn/docs/quick-start-docker.html" target="_self">Nacos Docker</a></li><li class="menu-item menu-item-level-3"><a href="/zh-cn/docs/use-nacos-with-dubbo.html" target="_self">Nacos Dubbo</a></li><li class="menu-item menu-item-level-3"><a href="/zh-cn/docs/use-nacos-with-kubernetes.html" target="_self">Nacos k8s</a></li><li class="menu-item menu-item-level-3"><a href="/zh-cn/docs/nacos-sync.html" target="_self">Nacos Sync</a></li></ul></li><li style="height:252px;overflow:hidden" class="menu-item menu-item-level-2"><span>用户指南<img style="transform:rotate(0deg)" class="menu-toggle" src="/img/arrow_down.png"/></span><ul><li class="menu-item menu-item-level-3"><a href="/zh-cn/docs/sdk.html" target="_self">Java的SDK</a></li><li class="menu-item menu-item-level-3"><a href="/zh-cn/docs/other-language.html" target="_self">其他语言的SDK</a></li><li class="menu-item menu-item-level-3"><a href="/zh-cn/docs/open-api.html" target="_self">Open-API指南</a></li><li class="menu-item menu-item-level-3"><a href="/zh-cn/docs/nacos-spring.html" target="_self">Nacos Spring</a></li><li class="menu-item menu-item-level-3"><a href="/zh-cn/docs/system-configurations.html" target="_self">Nacos系统参数介绍</a></li><li class="menu-item menu-item-level-3"><a href="/zh-cn/docs/faq.html" target="_self">FAQ</a></li></ul></li><li style="height:36px;overflow:hidden" class="menu-item menu-item-level-2"><span>运维指南<img style="transform:rotate(-90deg)" class="menu-toggle" src="/img/arrow_down.png"/></span><ul><li class="menu-item menu-item-level-3"><a href="/zh-cn/docs/deployment.html" target="_self">部署手册</a></li><li class="menu-item menu-item-level-3"><a href="/zh-cn/docs/cluster-mode-quick-start.html" target="_self">集群部署说明</a></li><li class="menu-item menu-item-level-3"><a href="/zh-cn/docs/management-api.html" target="_self">运维API</a></li><li class="menu-item menu-item-level-3"><a href="/zh-cn/docs/console-guide.html" target="_self">控制台手册</a></li><li class="menu-item menu-item-level-3"><a href="/zh-cn/docs/monitor-guide.html" target="_self">监控手册</a></li><li class="menu-item menu-item-level-3"><a href="/zh-cn/docs/nacos-config-benchmark.html" target="_self">服务配置模块压测报告</a></li><li class="menu-item menu-item-level-3"><a href="/zh-cn/docs/nacos-naming-benchmark.html" target="_self">服务发现模块压测报告</a></li><li class="menu-item menu-item-level-3"><a href="/zh-cn/docs/nacos-sync-use.html" target="_self">其他环境迁移到Nacos</a></li></ul></li><li style="height:36px;overflow:hidden" class="menu-item menu-item-level-2"><span>开源共建<img style="transform:rotate(-90deg)" class="menu-toggle" src="/img/arrow_down.png"/></span><ul><li class="menu-item menu-item-level-3"><a href="/zh-cn/docs/contributing.html" target="_self">贡献源码</a></li><li class="menu-item menu-item-level-3"><a href="/zh-cn/docs/contributing-flow.html" target="_self">贡献流程</a></li><li class="menu-item menu-item-level-3"><a href="/zh-cn/docs/pull-request.html" target="_self">pull request模板</a></li><li class="menu-item menu-item-level-3"><a href="/zh-cn/docs/how-to-reporting-bugs.html" target="_self">如何提交问题报告</a></li></ul></li><li style="height:36px;overflow:hidden" class="menu-item menu-item-level-2"><span>社区<img style="transform:rotate(-90deg)" class="menu-toggle" src="/img/arrow_down.png"/></span><ul><li class="menu-item menu-item-level-3"><a href="/zh-cn/docs/community.html" target="_self">社区</a></li><li class="menu-item menu-item-level-3"><a href="/zh-cn/docs/nacos-dev.html" target="_self">开发团队</a></li></ul></li></ul></li></ul></div><div class="doc-content markdown-body"><h1>如何贡献</h1>
<p>我们非常欢迎您的贡献和加入，无论是微不足道的清理或大的新功能。我们希望为每个编程语言提供高质量、有良好文档的代码。</p>
<p>这也不是代码是唯一有贡献项目的方式。我们非常重视文档、与其他项目的集成，并欣然接受这些方面的改进。</p>
<h2>联系我们</h2>
<h4>Nacos Gitter-<a href="https://gitter.im/alibaba/nacos">https://gitter.im/alibaba/nacos</a></h4>
<h4>Nacos 微博-<a href="https://weibo.com/u/6574374908">https://weibo.com/u/6574374908</a></h4>
<h4>Nacos segmentfault-<a href="https://segmentfault.com/t/nacos">https://segmentfault.com/t/nacos</a></h4>
<h4>邮件列表</h4>
<p>邮件列表建议讨论任何与Nacos有关的事情。具体请看<a href="https://github.com/apache/incubator-dubbo/wiki/Mailing-list-subscription-guide">参考手册</a>描述如何订阅我们的邮件列表。</p>
<ul>
<li><a href="https://lark.alipay.com/nacos/nacosdocs/vl19q1">dev-nacos@googlegroups.com</a>: 开发邮件列表。如果你在使用或开发Nacos中遇到任何问题,可以在这里提问题。</li>
<li><a href="https://lark.alipay.com/nacos/nacosdocs/vl19q1">commits-nacos@googlegroups.com</a>: 所有提交将被发送到这个邮件列表。如果你有兴趣Nacos的发展，你可以订阅它。</li>
<li><a href="https://lark.alipay.com/nacos/nacosdocs/vl19q1">users-nacos@googlegroups.com</a>: 在Github中<a href="https://github.com/alibaba/nacos/issues">提问题</a>、更新和<a href="https://github.com/alibaba/nacos/pulls">提交需求</a>将被发送到这个邮件列表。</li>
<li><a href="https://lark.alipay.com/nacos/nacosdocs/vl19q1">nacos_dev@linux.alibaba.com</a>.</li>
</ul>
<h2>贡献代码</h2>
<h3>贡献代码须知</h3>
<p>请贡献代码时候，请先确认和检查以下内容：</p>
<h4>阅读Nacos<a href="https://github.com/alibaba/nacos/blob/develop/style/codeStyle.md">代码规约</a> ，并根据指引设置IDE的codeStyle及校验插件。</h4>
<h4>如果变化不大，请编写一些覆盖新功能的单元测试。</h4>
<h4>如果你正在引入一个全新的特性或API，那么首先启动wiki并在基本设计上达成共识，再开始投入。</h4>
<h3>贡献流程</h3>
<p>这是贡献者的大致工作流程：</p>
<ul>
<li>fork当前存储github库。</li>
<li>创建一个分支，作为贡献的基础，这通常是develop分支。</li>
<li>做出一些变更提交。</li>
<li>确保提交消息的格式正确（见下文）。</li>
<li>推送变更到你的fork仓库中。</li>
<li>按照<a href="https://nacos.io/zh-cn/docs/pull-request.html">拉取请求模板</a>中的清单进行操作。</li>
<li>在发送拉取请求之前，请将您的fork仓库与远程存储库同步，这将使您的拉取请求变得简单明了。详情见下面的指南：</li>
</ul>
<pre><code>git remote add upstream git@github.com:alibaba/nacos.git
git fetch upstream
git rebase upstream/master
git checkout -b your_awesome_patch
... add some work
git push origin your_awesome_patch
</code></pre>
<ul>
<li>
<p>提交pull request 到 alibaba/nacos，等待回复。如果回复的慢，请无情的催促。</p>
</li>
<li>
<p>详细的贡献流程可参考<a href="contributing-flow.html">贡献流程</a></p>
</li>
</ul>
<h2>贡献文档</h2>
<h3>贡献文档须知</h3>
<p>请贡献文档时候，请先确认和检查以下内容：</p>
<h4>已确认过文档确实有误或存在缺失。</h4>
<h4>熟悉<a href="https://www.markdownguide.org/getting-started">Markdown</a> 。</h4>
<h4>熟悉<a href="https://github.com/txd-team/docsite">docsite</a> ，至少能够根据<a href="https://github.com/nacos-group/nacos-group.github.io">官方文档README.md</a> 的引导完成本地调试</h4>
<h3>贡献流程</h3>
<p>可参考<a href="contributing-flow.html">贡献流程</a></p>
<h2>成为提交者</h2>
<p>我们会积极纳入新的贡献者。我们更关注的是一系列的持续贡献，良好的品味和对项目维护的持续兴趣。如果你想成为一个提交者（Committer），请让一个现有的提交者(Committer)知道，他们会帮助你通过贡献加入我们。</p>
<p>现在，我们有几个重要的贡献点：</p>
<h4>Wiki &amp; JavaDoc</h4>
<h4>Nacos Console</h4>
<h4>Nacos SDK(<a href="http://C++.Net">C++.Net</a>\Php\Python\Go\Node.js)</h4>
<h4>前提</h4>
<p>如果你想贡献以上的项，请你必须遵守我们的一些先决条件：</p>
<h5>可读性，一个API必须具有JavaDoc，一些非常重要的方法也必须有JavaDoc。</h5>
<h5>可测性，关于测试过程的单元测试覆盖率（80%）</h5>
<h5>可维护性，可满足我们的<a href="https://github.com/alibaba/nacos/blob/develop/style/codeStyle.md">代码规约</a> ，以及至少3个月的更新频率</h5>
<h5>可部署性，我们可以鼓励您部署到<a href="http://search.maven.org/">maven repository</a></h5>
</div></div></section><footer class="footer-container"><div class="footer-body"><img src="/img/nacos_gray.png"/><div class="cols-container"><div class="col col-12"><h3>愿景</h3><p>Nacos 通过提供简单易用的动态服务发现、服务配置、服务共享与管理等服务基础设施，帮助用户在云原生时代，在私有云、混合云或者公有云等所有云环境中，更好的构建、交付、管理自己的微服务平台，更快的复用和组合业务服务，更快的交付商业创新的价值，从而为用户赢得市场。</p></div><div class="col col-6"><dl><dt>文档</dt><dd><a href="/zh-cn/docs/what-is-nacos.html" target="_self">概览</a></dd><dd><a href="/zh-cn/docs/quick-start.html" target="_self">快速开始</a></dd><dd><a href="/zh-cn/docs/contributing.html" target="_self">开发者指南</a></dd></dl></div><div class="col col-6"><dl><dt>资源</dt><dd><a href="/zh-cn/community/index.html" target="_self">社区</a></dd><dd><a href="https://www.aliyun.com/product/acm?source_type=nacos_pc_20181219" target="_self">云服务 ACM</a></dd><dd><a href="https://www.aliyun.com/product/edas?source_type=nacos_pc_20181219" target="_self">云服务 EDAS</a></dd><dd><a href="https://www.aliyun.com/product/ahas?source_type=nacos_pc_20190225" target="_self">云服务 AHAS</a></dd></dl></div></div><div class="copyright"><span>@ 2018 The Nacos Authors | An Alibaba Middleware (Aliware) Project</span></div></div></footer></div></div>
	<script src="https://f.alicdn.com/react/15.4.1/react-with-addons.min.js"></script>
	<script src="https://f.alicdn.com/react/15.4.1/react-dom.min.js"></script>
	<script>
		window.rootPath = '';
  </script>
	<script src="/build/documentation.js"></script>
</body>
</html>